<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: OpenSocial::Request</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">OpenSocial::Request</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../files/lib/opensocial/request_rb.html">
                lib/opensocial/request.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                Object
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
Provides a wrapper for a single request to an OpenSocial endpoint, either
as a standalone request, or as a fragment of an RPC request.
</p>
<p>
The <a href="Request.html">Request</a> class wraps an HTTP request to an
OpenSocial endpoint for social data. A <a href="Request.html">Request</a>
may be used, directly, to access social resources that may not be currently
wrapped by <a href="Request.html">Request</a>&#8216;s child classes. Used
in this was it gives near-raw access to social data. The <a
href="Request.html">Request</a> class supplies <a
href="../OAuth.html">OAuth</a> signing when the supplied connection
contains appropriate credentials.
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000020">new</a>&nbsp;&nbsp;
      <a href="#M000021">send_request</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">


    <div id="constants-list">
      <h3 class="section-bar">Constants</h3>

      <div class="name-list">
        <table summary="Constants">
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">GET</td>
          <td>=</td>
          <td class="context-item-value">'.get'</td>
        </tr>
        </table>
      </div>
    </div>



    <div id="attribute-list">
      <h3 class="section-bar">Attributes</h3>

      <div class="name-list">
        <table>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">connection</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
Defines the connection that will be used in the request.

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">guid</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
Defines the guid for the request.

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">key</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
Defines the key used to lookup the request result in an RPC request.

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">pid</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
Defines the pid for the request.

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">selector</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
Defines the selector for the request.

</td>
        </tr>
        </table>
      </div>
    </div>
      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000020" class="method-detail">
        <a name="M000020"></a>

        <div class="method-heading">
          <a href="Request.src/M000020.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000020.html');return false;">
          <span class="method-name">new</span><span class="method-args">(connection = nil, guid = nil, selector = nil, pid = nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Initializes a request using the optionally supplied connection, guid,
selector, and pid.
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000021" class="method-detail">
        <a name="M000021"></a>

        <div class="method-heading">
          <a href="Request.src/M000021.html" target="Code" class="method-signature"
            onclick="popupCode('Request.src/M000021.html');return false;">
          <span class="method-name">send_request</span><span class="method-args">(service, guid, selector = nil, pid = nil, unescape = false)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Generates a request given the service, guid, selector, and pid, to the
OpenSocial endpoint by constructing the service URI and dispatching the
request. When data is returned, it is parsed as JSON after being optionally
unescaped.
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>